Skip to content

Стабилизация CDPI UI: исправления ошибок, безопасность трея, обновления, тесты, CI и документация - #2

Merged
lumenpearson merged 202 commits into
mainfrom
stabilization
Oct 23, 2026

Conversation

@lumenpearson

@lumenpearson lumenpearson commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

Ветка stabilization основана на main основного репозитория Storik4pro/cdpiui (коммит f6f59c6, он же текущая вершина main). Изменения не меняют форматы данных: пресеты, элементы Магазина, Settings.xml, .cdpiconfig и .cdpipatch читаются как раньше.

Кратко

  • 202 коммита, 436 файлов, +13 893 / −4 834 строки.
  • Исправлены ошибки корректности, надёжности и безопасности во всех проектах: GUI, Core, Shared, AddOns, трей, Update.exe, EditHostFile, установщик.
  • Закрыта граница привилегий между GUI и треем, работающим от имени администратора.
  • Восстановлена цепочка обновления через .cdpipatch (сборка патча, подпись каталога, установка, откат).
  • Добавлены модульные тесты (192 теста) и CI: сборка библиотек, тесты, сборка GUI, сверка файлов установщика, сборка Setup.msi.
  • Написана документация для всех проектов и переписана справка в приложении.
  • После слияния документация разработчика переведена на русский язык (раздел 9).

Сравнение кода: main (f6f59c6) → эта ветка

Подсчёт scc по рабочим деревьям обеих версий:

Показатель main Ветка Разница
Файлов C# 497 539 +42
Строк кода C# (без комментариев и пустых) 80 978 85 215 +4 237 (+5,2 %)
Строк комментариев C# 1 633 2 348 +715 (+44 %)
Цикломатическая сложность C# (сумма) 7 722 8 345 +623 (+8,1 %)
Строк XAML 17 990 18 018 +28
Файлов Markdown (документация и справка) 70 89 +19
Строк Markdown 2 807 5 020 +2 213 (+79 %)
Модульных тестов 0 192 (91 метод) +192
Workflow CI 1 (только ручная сборка релиза) 2 (CI на каждый push и PR + сборка релиза) +1

Рост сложности приходится на проверки, которых раньше не было: входные данные из сети и от пользователя, пути файлов, ошибки и отмена операций. Комментарии объясняют, почему код написан так, а не что он делает.

Изменения по проектам (git diff --shortstat):

Проект Файлов Добавлено Удалено
CDPIUI (GUI) 242 3 010 1 421
CDPIUI.Core 52 2 276 769
CDPIUI.Shared 35 1 585 414
CDPIUI.AddOns 25 2 162 1 239
CDPIUI.TrayIcon 28 1 662 285
CDPIUI.Tests (новый) 30 1 342 0
Update 5 438 215
EditHostFile 3 248 28
NewSetup 4 187 70
.github 9 895 367

Оценка архитектуры и безопасности: до и после

Обе версии проверены одним способом: инвентаризация кода, карта зависимостей и разбор безопасности. Каждую находку подтверждала отдельная проверка, ложные срабатывания отброшены.

Показатель main (f6f59c6) Ветка
Находки безопасности: критичные 0 0
Находки безопасности: высокие 4 0
Находки безопасности: средние 6 4
Находки безопасности: низкие 3 8, из них 2 исправлены после проверки
Zip-slip 3 места (пакеты Магазина, синхронизация репозитория, Update.exe) нет
Доступ к pipe трея Everyone, ReadWrite трей, пользователь рабочего стола, SYSTEM; проверка исполняемого файла клиента
Запуск файлов треем по запросу любой путь только доверенные папки без символических ссылок
Права на папки Магазина Everyone, Full control пользователь трея, Modify
Проверка пакета обновления нет подписанный каталог
Модульные тесты нет 192
Рекомендуемый путь развития рефакторинг рефакторинг

Высокие находки main, которых нет в ветке:

  • pipe трея, работающего от имени администратора, открыт на запись для всех пользователей; единственная защита — постоянный GUID;
  • клиент pipe может заставить трей запустить любой exe, MSI или архив обновления;
  • GrantAccess выдаёт Everyone полный доступ к любой переданной папке;
  • zip-slip при распаковке пакетов Магазина.

Что осталось

Все пункты ниже исправлены в PR #3.

Средние:

  1. Обновление в формате MSI запускается без проверки подписи, потому что опубликованные Setup.msi не подписаны. Нужны подпись MSI и проверка перед msiexec.
  2. Трей доверяет папке %LOCALAPPDATA%\CDPIUI, в которую может писать пользователь. Для portable-версии это неизбежно; для MSI доверенные папки можно ограничить папкой установки.
  3. Путь и аргументы запускаемого файла приходят от клиента pipe. Путь проверяется по префиксу, файл перед запуском не копируется.
  4. Токены Магазина и ключ прокси встроены в сборку. Лучше использовать токены только для чтения или прокси с короткоживущими ключами.

Низкие:

  • секрет pipe постоянный: он одинаков во всех копиях и не меняется между релизами (две находки с одной причиной);
  • ZipService не ограничивает число и размер записей и не отклоняет символические ссылки (для .cdpiconfig такие ограничения уже есть);
  • пакет обновления распаковывается до проверки каталога;
  • импортируемые конфигурации могут указывать абсолютные пути или ..;
  • исправлено: секрет pipe сравнивается за постоянное время;
  • исправлено: файл целей проверки пресетов принимает только адреса http и https, поэтому значение не может стать опцией curl.

Технический долг (обе версии)

  • Крупные классы: ConfigMakerUserControl.xaml.cs (3 574 строки) и App.xaml.cs (окна, активация, миграция и восстановление в одном классе).
  • async void вне обработчиков UI в трее.
  • Около 80 пустых catch в путях запуска процессов, работы с файлами и удаления.
  • Update и EditHostFile работают на .NET Framework 4.7.2; их можно перевести на .NET 8.
  • Тесты не покрывают GUI и трей.

Что сделано

1. Безопасность и граница привилегий

Трей работает от имени администратора, поэтому всё, что он запускает или пишет, проверяется.

  • Pipe между GUI и треем.
    • Доступ ограничен пользователем трея, пользователем рабочего стола и SYSTEM, сетевые клиенты запрещены.
    • Каждая сторона проверяет исполняемый файл другой стороны.
    • До авторизации трей отправляет только служебные сообщения.
    • Клиент без авторизации отключается через 15 секунд. Клиент с неверным секретом отключается сразу.
    • Пустой секрет не авторизует никого.
    • Секрет не попадает в логи.
  • Пути и пакеты.
    • Трей запускает файлы, MSI и архивы обновлений только из папки установки или папок данных CDPI UI, и только если в пути нет символических ссылок и junction.
    • Пакеты копируются во временную папку и проверяются по подписи до запуска.
    • Права на папки Магазина выдаются пользователю трея (Modify), а не всем (Full control).
  • Ссылки cdpiui://.
    • Ссылки из браузера и из справки принимают только публичные маршруты.
    • Раньше любая веб-страница могла подделать ответы трея или открыть окно по имени типа.
    • Типы окон ограничены окнами самого приложения.
  • Архивы.
    • Пути внутри zip проверяются до распаковки (zip-slip).
    • Для .cdpiconfig ограничены размер, число файлов и степень сжатия.
    • Подписанные архивы распаковываются в отдельную папку и переносятся только после проверки каталога.
  • Общие пресеты и отчёты BlockCheck2. Опции, которые заставляют компонент писать файлы (--debug=@, --wf-save, --hostlist-auto), допускаются только внутри пакета. Это проверяется при импорте и при экспорте.
  • Ссылки из манифестов Магазина и лицензий открываются только по схемам http, https, mailto и tg.
  • Установщик запускает GUI после установки от имени пользователя, а не с правами установщика. После тихой установки GUI не запускается.
  • System.Security.Cryptography.Pkcs обновлён с 8.0.1 до 8.0.2: у 8.0.1 есть известные уязвимости.

2. Обновление приложения

  • Патч собирается из итоговой папки сборки, каталог catalog.cat подписывается и проверяется.
  • Update.exe входит в MSI.
  • Update.exe распаковывает обновление во временную папку и переносит заменяемые файлы в резервную. При ошибке файлы возвращаются из резервной папки, поэтому неудачное обновление не оставляет смесь версий.
  • Патчи дифференциальные, поэтому Update.exe больше не удаляет файлы, которых нет в очередном патче. Раньше удалялись файлы, принесённые предыдущими патчами.
  • Обязательные патчи берут версию из своего requirements.json, применяются по возрастанию версии и не пересекаются по папкам.
  • Релизная сборка берёт Secret.cs из секретов репозитория (новый скрипт create_release_secret.ps1). Раньше она доверяла пустому списку сертификатов и отвергала собственные патчи. Секрет pipe стабилен между релизами, поэтому патч не включает Shared и трей без причины.
  • MSI записывает папку установки в реестр, и приложение определяет тип установки (MSI или portable) во время работы. Раньше обе версии искали обновления в формате MSI.

3. Трей и компоненты

  • Компоненты, запущенные треем, входят в job object и завершаются вместе с треем, также при его аварийном завершении.
  • Настройки системного прокси пользователя сохраняются в файл и восстанавливаются после сбоя трея. Запись идёт в куст пользователя рабочего стола.
  • Псевдоконсоль:
    • CreateProcessW вместо ANSI-версии;
    • корректное чтение UTF-8 по кускам;
    • нет утечек дескрипторов;
    • ограниченное ожидание остановки;
    • правильное сопоставление ошибок.
  • Один экземпляр трея на систему (глобальный мьютекс).
  • Исправлены ([Audit 22.3-predictable-proxy-secret / historical] TgWsProxy secret uses non-cryptographic PRNG #68):
    • падение меню трея;
    • ConditionalLaunch: горячие клавиши, наблюдатель папки, сохранение состояния задач.
  • Сообщения окнам при закрытом GUI больше не теряются.
  • Запросы вывода и состояния компонента отвечают для запрошенного компонента.

4. Магазин, пресеты, импорт

5. Дополнения

  • GoodCheck.
    • Читается весь лог текущего запуска.
    • Ранний сбой не считается успехом.
    • Неудачный старт не вешает операцию.
    • Исправлено целочисленное деление при подсчёте успеха.
  • BlockCheck2.
    • Списки сайтов не разбиваются при подборе стратегии.
    • Ограничены размеры импортируемого отчёта.
    • Исправлено распознавание заглушек провайдера.
    • Повреждённый файл истории не скрывает всю историю.
  • Troubleshooting.
    • Убраны ложные срабатывания проверок служб.
    • Исправление WinDivert проверяется.
    • Добавлены тайм-ауты.
  • ConfigShare. Пустой список --hostlist-auto передаётся без создания файлов в наборе пользователя.

6. GUI

  • Необработанные исключения в асинхронных обработчиках выводятся в окне ошибки, а не закрывают приложение.
  • Обращения к UI из фоновых потоков переведены на поток UI.
  • Устранены утечки подписок на события и общие коллекции по умолчанию в элементах управления.
  • Исправлены NRE на удалённых пакетах и пустых целях конфига.
  • Сброс тестового запуска при уходе со страницы.
  • Справка:
    • открываются корневые статьи;
    • работают внешние ссылки;
    • меню сортируется.
  • Окна, открытые во время старта, ждут готовности локализации.
  • Сборка только под x64. Конфигурация x86 падала на SetWindowLongPtrW.
  • Опечатки в идентификаторах исправлены (Extention, Convertion, Runned, Preffix, Backgroud и другие). Значения, которые хранятся на диске или в JSON Магазина, не изменились.

7. Сборка, тесты и CI

  • Новый проект CDPIUI.Tests (xUnit). Покрыты:
    • пути архивов и pipe;
    • разбор командной строки;
    • переменные и LScript;
    • конвертер Zapret → Zapret2;
    • версии;
    • кодировки .bat;
    • настройки XML;
    • прокси;
    • ConfigShare.
  • CI (.github/workflows/ci.yml) на каждый push и PR:
    • сборка Shared, Core, AddOns и трея, тесты;
    • сборка GUI и portable-раскладки;
    • сверка списка файлов MSI с раскладкой;
    • сборка Setup.msi (артефакт);
    • сборка Update и EditHostFile.
  • Скрипты .github/scripts: build_portable.ps1, check_setup_files.ps1, make_patch.ps1, create_secret_stub.ps1, create_release_secret.ps1.
  • Удалены неиспользуемые пакеты и расширения WiX. Из сборки убраны языковые файлы Windows App SDK, кроме английского и русского.

8. Документация и архитектура

  • README.md для каждого проекта: GUI, Core, Shared, трей, AddOns и каждое дополнение, тесты, Update, EditHostFile, установщик, CI и релизы.
  • Отдельно описаны протокол pipe (CDPIUI.Shared/Pipe/README.md) и язык LScript (CDPIUI.Core/LScript/README.md).
  • CONTRIBUTING.md переписан под текущую сборку, структуру и правила изменения кода.
  • Документация на английском написана по стандарту ASD-STE100 (Simplified Technical English).
  • Справка в приложении:
    • английские статьи переписаны по ASD-STE100;
    • добавлены недостающие статьи;
    • исправлены ссылки и опечатки;
    • статьи EN и RU синхронизированы.
  • THIRD-PARTY-NOTICES.md — список сторонних библиотек сборки и их лицензий.

9. После слияния: документация на двух языках и исправления в main

После слияния в main добавлены 4 коммита (+4 986 / −18 строк, 42 файла):

  • Для каждого документа разработчика добавлена русская версия *.ru.md рядом с английской: README всех проектов и дополнений, протокол pipe, язык LScript, CONTRIBUTING, RELEASES, THIRD-PARTY-NOTICES — 20 документов, около 5 000 строк.
    • В начале каждого документа есть переключатель языка.
    • Ссылки в русских версиях ведут на русские версии других документов. Для якорей сохранены английские идентификаторы.
    • Справка в приложении (66 статей) и ELUA уже были на двух языках.
  • .github/README.md переименован в .github/RELEASES.md: GitHub показывал его на главной странице вместо корневого README.md.
  • Корневой README.md дополнен разделами «Как устроено приложение», «Сборка из исходного кода» и «Документация». Текст основного репозитория сохранён полностью.
  • По ходу перевода исправлены неточности в английских документах: три подписи интерфейса BlockCheck2, сломанная строка таблицы GoodCheck, правило числа запусков в ConfigImport, папки очистки при удалении в NewSetup.
  • Файл целей проверки пресетов принимает только адреса http и https: значение, которое начиналось с -, становилось параметром curl.

Оставшиеся находки оценки безопасности и технический долг исправлены в PR #3.

Проверка

  • CI: библиотеки собираются, 192 теста проходят, GUI собирается, список файлов установщика совпадает, Setup.msi собирается, Update и EditHostFile собираются.
  • Update.exe (промежуточная папка и откат) и EditHostFile (кодировки и переводы строк) проверены на настоящих исходниках в тестовых сборках .NET 8.
  • Не проверено: работа GUI и трея на Windows в реальном использовании. Перед слиянием нужна ручная проверка основных сценариев:
    • установка MSI и portable;
    • запуск компонента;
    • Магазин;
    • обновление патчем;
    • импорт .bat.

Для релиза

В секретах репозитория нужны:

Подробности — в .github/RELEASES.md.

Integer division made every strategy below 100% count as failed.
Update checks compared against an empty version and never reported updates.
Entries that resolve outside of the target directory now fail extraction. A missing root folder argument no longer throws.
Characters such as + & # % were altered by query string parsing, which corrupted component arguments and file paths.
Lookup and insertion now happen under one lock, and bulk operations enumerate a snapshot of the task list.
Overlapping updates could interleave clear and add operations and show duplicate rows.
A sharing violation while the other process read Settings.xml disabled saving for the rest of the session. Numbers and dates are now written in invariant format and values written in the current culture by older versions are still read. Missing keys in nested groups use template defaults.
Prefixed error code strings were parsed as enum names, which threw inside catch blocks and lost the original error.
Stopping a component only disabled the proxy and left the server value, which also replaced a proxy the user had configured before.
Also tolerate a malformed tray icon id in settings and keep the resume handler from crashing the tray.
A slow tray start made the UI launch a second tray instance and close itself without showing anything.
The cache key did not include the converter version, so fixes in the converter never reached existing installations.
An empty or per-protocol ProxyServer value threw while the page was created. Defaults are used when the value cannot be parsed.
The close was cancelled only after an await, so the window closed and the unsaved preset was lost.
The loop stopped at the first kit whose items were already installed.
The success dialog was shown and the component pointed at a preset that was never written.
This was referenced Nov 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:reliability Cancellation, errors, races, data preservation and recovery. area:security Trusted paths, privileges, pipe trust, signatures and protected operations. type:bug Fix a reproducible defect in application behavior.

Projects

Development

Successfully merging this pull request may close these issues.

1 participant